org.springframework.web.util.pattern

Class CaptureVariablePathElement

java.lang.Object

org.springframework.web.util.pattern.PathElement

org.springframework.web.util.pattern.CaptureVariablePathElement

class CaptureVariablePathElement
extends PathElement

A path element representing capturing a piece of the path as a variable. In the pattern '/foo/{bar}/goo' the {bar} is represented as a CaptureVariablePathElement. There must be at least one character to bind to the variable.

Since:

5.0

Author:

Andy Clement

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.regex.Pattern	constraintPattern
private java.lang.String	variableName

Fields inherited from class org.springframework.web.util.pattern.PathElement

CAPTURE_VARIABLE_WEIGHT, next, NO_PARAMETERS, pos, prev, separator, WILDCARD_WEIGHT

Constructor Summary

Constructors

Constructor and Description
CaptureVariablePathElement(int pos, char[] captureDescriptor, boolean caseSensitive, char separator)

Method Summary

Modifier and Type	Method and Description
int	getCaptureCount() Return the number of variables captured by the path element.
char[]	getChars()
int	getNormalizedLength()
int	getScore() Return the score for this PathElement, combined score is used to compare parsed patterns.
java.lang.String	getVariableName()
int	getWildcardCount() Return the number of wildcard elements (*, ?) in the path element.
boolean	matches(int pathIndex, PathPattern.MatchingContext matchingContext) Attempt to match this path element.
java.lang.String	toString()

Methods inherited from class org.springframework.web.util.pattern.PathElement

isNoMorePattern

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

variableName

private final java.lang.String variableName

constraintPattern

@Nullable
private java.util.regex.Pattern constraintPattern

Constructor Detail

CaptureVariablePathElement

CaptureVariablePathElement(int pos,
                           char[] captureDescriptor,
                           boolean caseSensitive,
                           char separator)

Parameters:

pos - the position in the pattern of this capture element

captureDescriptor - is of the form {AAAAA[:pattern]}

Method Detail

matches

public boolean matches(int pathIndex,
                       PathPattern.MatchingContext matchingContext)

Description copied from class: PathElement

Attempt to match this path element.

Specified by:

matches in class PathElement

Parameters:

pathIndex - the current position within the candidate path

matchingContext - encapsulates context for the match including the candidate

Returns:

true if it matches, otherwise false

getVariableName

public java.lang.String getVariableName()

getNormalizedLength

public int getNormalizedLength()

Specified by:

getNormalizedLength in class PathElement

Returns:

the length of the path element where captures are considered to be one character long.

getWildcardCount

public int getWildcardCount()

Description copied from class: PathElement

Return the number of wildcard elements (*, ?) in the path element.

Overrides:

getWildcardCount in class PathElement

getCaptureCount

public int getCaptureCount()

Description copied from class: PathElement

Return the number of variables captured by the path element.

Overrides:

getCaptureCount in class PathElement

getScore

public int getScore()

Description copied from class: PathElement

Return the score for this PathElement, combined score is used to compare parsed patterns.

Overrides:

getScore in class PathElement

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getChars

public char[] getChars()

Specified by:

getChars in class PathElement